-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hub Generated] Review request for Microsoft.HybridCompute to add version preview/2023-04-25-preview #23732
[Hub Generated] Review request for Microsoft.HybridCompute to add version preview/2023-04-25-preview #23732
Conversation
…023-03-15-preview to version 2023-04-25-preview
Hi, @vedkale Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
HybridCompute.json | 2023-04-25-preview(22fa227) | 2022-12-27(main) |
HybridCompute.json | 2023-04-25-preview(22fa227) | 2023-03-15-preview(main) |
privateLinkScopes.json | 2023-04-25-preview(22fa227) | 2022-12-27(main) |
privateLinkScopes.json | 2023-04-25-preview(22fa227) | 2023-03-15-preview(main) |
️❌
CredScan: 0 Errors, 0 Warnings failed [Detail]
️⚠️
LintDiff: 9 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-preview-2023-04 | package-preview-2023-04(22fa227) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L271 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L334 |
||
The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L1382 |
RPC-Async-V1-06 | |
200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L1487 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L2695 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L2900 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L2989 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L3130 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L3207 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Machines_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L38 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L74 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L203 |
ResourceNameRestriction |
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L475 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L476 |
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'MachineExtensions_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L476 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L519 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L526 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L625 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L813 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L813 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L989 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L1026 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L1077 |
BodyTopLevelProperties |
Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'Machine' has extra properties ['resources']. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L2175 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'MachineExtension'. Properties [properties.type] conflict with ARM top level properties. Please rename these. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json#L2282 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L115 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L116 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L311 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L356 |
ResourceNameRestriction |
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L356 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L401 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L401 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L449 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L484 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L491 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L508 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L575 |
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L659 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json#L659 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 55 Errors, 0 Warnings failed [Detail]
Tag package-preview-2023-04; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 41, untested: 0, failed: 32, passed: 9
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: Machines_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: code Source: response OperationId: Machines_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: message Source: response OperationId: Machines_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: target Source: response OperationId: Machines_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/machines/machinenacklss' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Machines_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: PatchResourceNotFound, errorMessage: The resource '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-GwiSMN-23732/providers/Microsoft.HybridCompute/machines/machinenacklss' was not found when evaluating policies for a PATCH operation. Source: runtime OperationId: Machines_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'nametolr7j' not found. Source: runtime OperationId: Machines_InstallPatches |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'nametolr7j' not found. Source: runtime OperationId: Machines_AssessPatches |
CLIENT_ERROR |
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: PrivateLinkScopes_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: code Source: response OperationId: PrivateLinkScopes_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: message Source: response OperationId: PrivateLinkScopes_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: target Source: response OperationId: PrivateLinkScopes_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: PrivateLinkScopes_GetValidationDetails |
INVALID_CONTENT_TYPE |
Invalid Content-Type (application/problem+json). These are supported: application/json Source: response OperationId: PrivateLinkScopes_GetValidationDetails |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: type Source: response OperationId: PrivateLinkScopes_GetValidationDetails |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: title Source: response OperationId: PrivateLinkScopes_GetValidationDetails |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: status Source: response OperationId: PrivateLinkScopes_GetValidationDetails |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: traceId Source: response OperationId: PrivateLinkScopes_GetValidationDetails |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: errors Source: response OperationId: PrivateLinkScopes_GetValidationDetails |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'machinenacklss' not found. Source: runtime OperationId: PrivateLinkScopes_GetValidationDetailsForMachine |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/privateLinkScopes/scopenamn1s2wv' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PrivateLinkScopes_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/privateLinkScopes/scopenamn1s2wv' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PrivateLinkScopes_UpdateTags |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'machinenacklss' not found. Source: runtime OperationId: MachineExtensions_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'machinenacklss' not found. Source: runtime OperationId: MachineExtensions_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/machines/machinenacklss/extensions/extensioz4hv5f' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachineExtensions_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/machines/machinenacklss/extensions/extensioz4hv5f' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachineExtensions_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/machines/machinenacklss' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachineRunCommands_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/machines/machinenacklss' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachineRunCommands_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/machines/machinenacklss' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachineRunCommands_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HybridCompute/machines/machinenacklss' under resource group 'apiTest-GwiSMN-23732' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachineRunCommands_Update |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @vedkale and @arcboard, one or more change(s) have been detected in your Arc enabled VM's or Arc enabled Server's RPs. Please review the changes and ensure that no gaps have been introduced with respect to the ARM API modeling consistency across Azure Arc and Azure Compute. For further details, see guidelines at Consistency in ARM Modeling. To approve the change(s), set the label to ArcSignedOff. If you have any questions, please mail to [email protected]. |
Hi @vedkale, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
@Wzb123456789 can I please get a review for this PR? It looks like CredScan is failing but there are no secrets in the example, is that ok? |
...mpute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json
Outdated
Show resolved
Hide resolved
@Wzb123456789 can I please get a review for this PR? |
Go sdk breaking change is false alarm. |
Awesome! Thank you @***@***.***>, @crystal ***@***.***>
@***@***.***> as fyi
…________________________________
From: Crystal YU ***@***.***>
Sent: Wednesday, May 31, 2023 10:29:15 PM
To: Azure/azure-rest-api-specs ***@***.***>
Cc: Raghu Shantha ***@***.***>; Review requested ***@***.***>
Subject: Re: [Azure/azure-rest-api-specs] [Hub Generated] Review request for Microsoft.HybridCompute to add version preview/2023-04-25-preview (PR #23732)
Merged #23732<#23732> into main.
—
Reply to this email directly, view it on GitHub<#23732 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACZPCYAW7QQLVMYQNZSRTJ3XJASCXANCNFSM6AAAAAAXMUC7YM>.
You are receiving this because your review was requested.Message ID: ***@***.***>
|
…sion preview/2023-04-25-preview (Azure#23732) * Adds base for updating Microsoft.HybridCompute from version preview/2023-03-15-preview to version 2023-04-25-preview * Updates readme * Updates API version in new specs and examples * add run command resource * fix errors * fix delete headers and list run command type * add delete example * change resource type run command * merge stable version changes * fix api version in examples * add http patch, pattern for machine name * add 201 to put and update body * add update example * add identifiers * add 201 response and name pattern * fix staging lint issues * undo commit * fix location header * switch to v3 * change final state via * add machineNameParamter * revert change to fix breaking change * fix tracked resource version for breaking change * address comments * address comments * run prettier * update description --------- Co-authored-by: Ved Kale <[email protected]>
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.